Skip to content

docs: remove project-status checklist#34

Merged
andygrove merged 1 commit into
apache:mainfrom
andygrove:docs/remove-project-status
May 13, 2026
Merged

docs: remove project-status checklist#34
andygrove merged 1 commit into
apache:mainfrom
andygrove:docs/remove-project-status

Conversation

@andygrove
Copy link
Copy Markdown
Member

Which issue does this PR close?

N/A — housekeeping.

Rationale for this change

The project-status checklist was added one day ago and was already
stale: SessionContextBuilder (#28), writeParquet (#27), and
additional DataFrame transformations (#30) all shipped after it was
written. Given the current rate of change, the page was misleading new
users about what is and isn't available. Future work will be tracked as
GitHub issues rather than a checked-in checklist.

What changes are included in this PR?

  • Delete docs/source/user-guide/project-status.md.
  • Remove the page from the user-guide toctree (docs/source/user-guide/index.md)
    and from the user-guide tagline in README.md.
  • dataframe.md: replace "exposes select and filter today; other
    transformations are TBD" with the actual current method list
    (select, filter, limit, distinct, dropColumns,
    withColumnRenamed).
  • sessioncontext.md: replace the "What's configurable today / not yet
    wired" stub with a "Configuration" section documenting
    SessionContext.builder() (which had no user-guide coverage despite
    shipping in feat: configure SessionContext and RuntimeEnv via builder #28).

How are these changes tested?

sphinx-build -b html -W --keep-going source build/html from docs/
succeeds with no warnings.

The checklist was already stale within a day of being added — the
SessionContextBuilder (apache#28), writeParquet (apache#27), and additional
DataFrame transformations (apache#30) shipped after it was written. Future
work will be tracked as GitHub issues instead.

Also refresh the two sentences that referenced it so they don't carry
stale claims forward: dataframe.md now lists the real current
transformations, and sessioncontext.md documents SessionContext.builder()
(which had no user-guide coverage).
@andygrove andygrove merged commit 2689011 into apache:main May 13, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant